<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Gets and sort messages</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="function.imap-setflag-full.html">« imap_setflag_full</a></li>
      <li style="float: right;"><a href="function.imap-status.html">imap_status »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="ref.imap.html">IMAP 函数</a></li>
    <li>Gets and sort messages</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="function.imap-sort" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_sort</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_sort</span> &mdash; <span class="dc-title">Gets and sort messages</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-sort-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_sort</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type IMAP\Connection">IMAP\Connection</span></span> <code class="parameter">$imap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">int</span> <code class="parameter">$criteria</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">bool</span> <code class="parameter">$reverse</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">?</span><span class="type"><span class="type">string</span><span class="type"></span></span> <code class="parameter">$search_criteria</code><span class="initializer"> = <strong><code>null</code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">?</span><span class="type"><span class="type">string</span><span class="type"></span></span> <code class="parameter">$charset</code><span class="initializer"> = <strong><code>null</code></strong></span></span><br>): <span class="type"><span class="type">array</span>|<span class="type"><span class="type false">false</span></span></span></div>

  <p class="para rdfs-comment">
   Gets and sorts message numbers by the given parameters.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-sort-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    <dt>

<code class="parameter">imap</code></dt>
<dd>
<p class="para"><span class="classname"><strong class="classname">IMAP\Connection</strong></span> 实例。</p></dd>

    
     <dt>
<code class="parameter">criteria</code></dt>

     <dd>

      <p class="para">
       Criteria can be one (and only one) of the following:
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTDATE</code></strong> - message Date
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTARRIVAL</code></strong> - arrival date
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTFROM</code></strong> - mailbox in first From address
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTSUBJECT</code></strong> - message subject
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTTO</code></strong> - mailbox in first To address
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTCC</code></strong> - mailbox in first cc address
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SORTSIZE</code></strong> - size of message in octets
         </span>
        </li>
       </ul>
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">reverse</code></dt>

     <dd>

      <p class="para">
       Whether to sort in reverse order.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">flags</code></dt>

     <dd>

      <p class="para">
       The <code class="parameter">flags</code> are a bitmask of one or more of the
       following:
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code>SE_UID</code></strong> - Return UIDs instead of sequence numbers
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code>SE_NOPREFETCH</code></strong> - Don&#039;t prefetch searched messages
         </span>
        </li>
       </ul>
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">search_criteria</code></dt>

     <dd>

      <p class="para">
       IMAP2-format search criteria string. For details see
       <span class="function"><a href="function.imap-search.html" class="function">imap_search()</a></span>.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">charset</code></dt>

     <dd>

      <p class="para">
       MIME character set to use when sorting strings.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-sort-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns an array of message numbers sorted by the given
   parameters,  或者在失败时返回 <strong><code>false</code></strong>.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-sort-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  现在 <code class="parameter">imap</code> 参数接受 <span class="classname"><strong class="classname">IMAP\Connection</strong></span>
  实例，之前接受 <a href="language.types.resource.html" class="link">资源(resource)</a>。
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">reverse</code> is now <span class="type">bool</span> instead of <span class="type">int</span>.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">search_criteria</code> and <code class="parameter">charset</code> are now <span class="type"><span class="type nullable">nullable</span></span>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>

</div></div></div></body></html>